API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

dataanalysis_dataprocessors

Retrieves a dataanalysis_dataprocessors resource.

Retrieves a dataanalysis_dataprocessors resource.

Authorizations:
JWT
path Parameters
id
required
string

dataanalysis_dataprocessors identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "title": "string",
  • "managerName": "default",
  • "seriesNames": "string",
  • "graphType": "string",
  • "notes": "string",
  • "cacheTTL": 3600,
  • "shortcode": "DP",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "seriesData": true,
  • "dataArrayToProcess": [
    ],
  • "dataProcessorCollectorsListing": null,
  • "requestParamsListing": [
    ],
  • "apiShortname": "string",
  • "tableName": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Replaces the dataanalysis_dataprocessors resource.

Replaces the dataanalysis_dataprocessors resource.

Authorizations:
JWT
path Parameters
id
required
string

dataanalysis_dataprocessors identifier

Request Body schema:
required

The updated dataanalysis_dataprocessors resource

title
required
string
Array of objects (dataanalysis_dataprocessorresults.jsonld-add_post)
managerName
required
string
Default: "default"
isSeriesData
required
boolean
seriesNames
string or null
graphType
string or null

// ex: barchart, gauge, piechart, etc.

notes
string or null
cacheTTL
integer
Default: 3600

Processor process cache TTL in seconds

deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>

Responses

Request samples

Content type
{
  • "title": "string",
  • "dataProcessorResults": [
    ],
  • "managerName": "default",
  • "isSeriesData": true,
  • "seriesNames": "string",
  • "graphType": "string",
  • "notes": "string",
  • "cacheTTL": 3600,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "title": "string",
  • "managerName": "default",
  • "seriesNames": "string",
  • "graphType": "string",
  • "notes": "string",
  • "cacheTTL": 3600,
  • "shortcode": "DP",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "seriesData": true,
  • "dataArrayToProcess": [
    ],
  • "dataProcessorCollectorsListing": null,
  • "requestParamsListing": [
    ],
  • "apiShortname": "string",
  • "tableName": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Removes the dataanalysis_dataprocessors resource.

Removes the dataanalysis_dataprocessors resource.

Authorizations:
JWT
path Parameters
id
required
string

dataanalysis_dataprocessors identifier

Responses